Skip to content

docs: project documentation + README v1.3.0 update#7

Merged
hrabbach merged 1 commit into
mainfrom
gsd/docs-update
Jun 26, 2026
Merged

docs: project documentation + README v1.3.0 update#7
hrabbach merged 1 commit into
mainfrom
gsd/docs-update

Conversation

@hrabbach

Copy link
Copy Markdown
Owner

Summary

Adds project documentation and brings the public README up to date with the v1.3.0 timed-motor features.

  • README.md (supplement, existing content preserved): new sections for motor types (bidirectional vs timed), manual device entry by hex ID, the event-free timed calibration flow, and driving a calibrated timed motor to a position.
  • docs/ARCHITECTURE.md — component responsibilities, serial protocol layer, dispatcher/signal flow, bidirectional-vs-timed control split, position tracking, calibration persistence.
  • docs/GETTING-STARTED.md — end-user quick start (install → hub setup → add/pair → calibrate → control).
  • docs/DEVELOPMENT.md — contributor setup, the WSL-tests / native-.venv-win ruff+mypy split, conventions, module layout.
  • docs/TESTING.md — exact .wsl_exec.sh invocation (with the PowerShell vs Git Bash MSYS_NO_PATHCONV caveat), test-file map, coverage, lint/type gate.
  • docs/CONFIGURATION.md — every real config option, sourced from const.py / manifest.json / the flows.

Docs-only change — no code, no version bump. All technical claims were spot-checked against the codebase (constants, VID/PID, baud, and the WSL test commands).

🤖 Generated with Claude Code

…uration guides; supplement README with v1.3.0 timed-motor flows
@hrabbach hrabbach merged commit 42fcd0f into main Jun 26, 2026
1 check passed
@hrabbach hrabbach deleted the gsd/docs-update branch June 26, 2026 18:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant